heapSpace

Type

function

Summary

Returns the number of free bytes in the application heap on Mac OS systems.

Syntax

the heapSpace

heapSpace()

Description

Use the heapSpace function to determine how much free memory remains.

This function exists to aid compatibility with imported HyperCard stacks. It may not return the exact amount of free memory. It also does not take available temporary memory into account.

On Unix and Windows systems, this function does not return a meaningful value.

Examples

the heapSpace

if the heapSpace < 1024^2 then suggestLowMemory

Related

control structure: function

function: hasMemory, stackSpace

glossary: byte, Mac OS, return

property: size, alwaysBuffer, destroyStack

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

Platforms

desktop

server